<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>Atom API Documentation</title>
  <link rel='stylesheet' href='../assets/biscotto.css' type='text/css'>
  <script src='../assets/biscotto.js'></script>
  <script src='../assets/search_data.js'></script>
</head>
  <body>
    <div id='base' data-path='..&#47;'></div>
<div id='header'>
  <div id='menu'>
    <a href='README.md.html' title='Atom'>Atom</a>
    &raquo;
    <a href='../class_index.html' title='Index'>Index</a>
    &raquo;
    <span class='title'>docs&#47;README.md</span>
    <nav>
      <ul>
        <li class='noframes'>
          (<a class='noframes' href='README.md.html#'>no frames</a>)
        </li>
      </ul>
    </nav>
    <div id='search'>
      <a id='class_list_link' href='../class_list.html'>Classes</a>
      <a id='file_list_link' href='../file_list.html'>Files</a>
      <a id='method_list_link' href='../method_list.html'>Methods</a>
      <a id='extra_list_link' href='../extra_list.html'>Extras</a>
    </div>
  </div>
  <iframe id='search_frame'></iframe>
  <div id='fuzzySearch'>
    <input type='text'>
    <ol></ol>
  </div>
  <div id='help'>
    <p>
      Quickly fuzzy find classes, mixins, methods, file:
    </p>
    <ul>
      <li>
        <span>Ctrl-T</span>
        Open fuzzy finder dialog
      </li>
    </ul>
    <p>
      In frame mode you can toggle the list naviation frame on the left side:
    </p>
    <ul>
      <li>
        <span>Ctrl-L</span>
        Toggle list view
      </li>
    </ul>
    <p>
      You can focus a list in frame mode or toggle a tab in frameless mode:
    </p>
    <ul>
      <li>
        <span>Ctrl-C</span>
        Class list
      </li>
      <li>
        <span>Ctrl-I</span>
        Mixin list
      </li>
      <li>
        <span>Ctrl-F</span>
        File list
      </li>
      <li>
        <span>Ctrl-M</span>
        Method list
      </li>
      <li>
        <span>Ctrl-E</span>
        Extras list
      </li>
    </ul>
    <p>
      You can focus and blur the search input:
    </p>
    <ul>
      <li>
        <span>Ctrl-S</span>
        Focus search input
      </li>
      <li>
        <span>Esc</span>
        Blur search input
      </li>
    </ul>
    <p>
      In frameless mode you can close the list tab:
    </p>
    <ul>
      <li>
        <span>Esc</span>
        Close list tab
      </li>
    </ul>
  </div>
</div>
    <div id='content'>
      <nav class='toc'>
        <p class='title'>
          <a class='hide_toc' href='README.md.html#'>
            <strong>Table of Contents</strong>
          </a>
          <small>
            (<a class='float_toc' href='README.md.html#'>left</a>)
          </small>
        </p>
      </nav>
      <div id='filecontents'>
        <h1 id="welcome-to-the-atom-api-documentation">Welcome to the Atom API Documentation</h1><p><img src="http://i.imgur.com/OrTvUAD.png" alt="Atom"></p><h2 id="faq">FAQ</h2>
<h3 id="where-do-i-start-">Where do I start?</h3><p>Check out <a href="../classes/EditorView.html">EditorView</a> and <a href="../classes/Editor.html">Editor</a> classes for a good
overview of the main editor API.</p><h3 id="how-do-i-access-these-classes-">How do I access these classes?</h3><p>Check out the <a href="../classes/Atom.html">Atom</a> class docs to see what globals are available and
what they provide.</p><p>You can also require many of these classes in your package via:</p><pre><code class="lang-coffee">{EditorView} = require &#39;atom&#39;
</code></pre><p>The classes available from <code>require &#39;atom&#39;</code> are:</p><ul>
<li><a href="../classes/BufferedProcess.html">BufferedProcess</a></li>
<li><a href="../classes/BufferedNodeProcess.html">BufferedNodeProcess</a></li>
<li><a href="../classes/EditorView.html">EditorView</a></li>
<li><a href="../classes/Git.html">Git</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Range.html">Range</a></li>
<li><a href="../classes/ScrollView.html">ScrollView</a></li>
<li><a href="../classes/SelectListView.html">SelectListView</a></li>
<li><a href="../classes/View.html">View</a></li>
<li><a href="../classes/WorkspaceView.html">WorkspaceView</a></li>
</ul>
<h3 id="how-do-i-create-a-package-">How do I create a package?</h3><p>You probably want to read the <a href="../../../../latest/creating-a-package.html">creating a package</a>
doc first and come back here when you are done.</p><h3 id="where-are-the-node-docs-">Where are the node docs?</h3><p>Atom ships with node 0.11.10 and the comprehensive node API docs are available
<a href="http://nodejs.org/docs/v0.11.10/api">here</a>.</p>
      </div>
    </div>
    <div id='footer'>
  Generated on
  Wed Mar 05 2014 08:55:13 GMT-0700 (MST)
  by
  <a href='https://github.com/gjtorikian/biscotto' title='TomDoc-CoffeeScript API documentation generator'>Biscotto</a>
  v2.1.1
  (Node.js v0.10.22).
  &#10034;
  Press Ctrl-h to see the keyboard shortcuts
</div>
  </body>
</html>